/**
 * Copyright (c) 2014, ControlsFX
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *     * Neither the name of ControlsFX, any associated website, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.actionfx.core.decoration;

import java.util.HashMap;
import java.util.Map;

import javafx.scene.Node;

/**
 * Class for ActionFX scenegraph decorations.
 * <p>
 * This class is inspired by ControlsFX' <a href=
 * "https://controlsfx.github.io/javadoc/11.1.1/org.controlsfx.controls/org/controlsfx/control/decoration/Decoration.html">Decoration</a>,
 * but refactored to ActionFX's needs, Java 11 and Clean Code standards.
 *
 */
public abstract class Decoration {

    private Map<String, Object> properties;

    /**
     * This method decorates the given target node with the relevant decorations.
     *
     * @param targetNode
     *            the node to decorate.
     */
    public abstract void applyDecoration(Node targetNode);

    /**
     * This method removes the decoration from the given target node.
     *
     * @param targetNode
     *            The node to undecorate.
     * @return {@code true}, if and only if removal of the decoration from the target node was successful.
     */
    public abstract boolean removeDecoration(Node targetNode);

    /**
     * Custom decoration properties
     *
     * @return decoration properties
     */
    public final synchronized Map<String, Object> getProperties() {
        if (properties == null) {
            properties = new HashMap<>();
        }
        return properties;
    }
}
